Merged
Conversation
Contributor
|
The code itself looks good. However, we are trying to make the Vitess code compliant to the Go styleguide, which includes having doccomments of the form // Foo foos the bar. In my experience this actually helps when you are trying to figure out what the code is doing. Can you please reword your doccomments in this spirit? |
Contributor
Author
|
I'm surprised to hear you say that. Quickly scanning the diff, the vast majority of important functions and structures (particularly the public functions) are quite well documented. Did you have a specific example where something in here needed more explanation? About the only example I can think of is the Election() method which is explained by comments on the structure itself. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.